<!DOCTYPE html>
<html lang="en">
  <head>
    <title>UIEmptyStateDataSource Protocol Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset="utf-8">
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
    <script src="../js/lunr.min.js" defer></script>
    <script src="../js/typeahead.jquery.js" defer></script>
    <script src="../js/jazzy.search.js" defer></script>
  </head>
  <body>

    <a name="//apple_ref/swift/Protocol/UIEmptyStateDataSource" class="dashAnchor"></a>

    <a title="UIEmptyStateDataSource Protocol Reference"></a>

    <header class="header">
      <p class="header-col header-col--primary">
        <a class="header-link" href="../index.html">
          UIEmptyState Docs
        </a>
         (100% documented)
      </p>
    
      <p class="header-col--secondary">
        <form role="search" action="../search.json">
          <input type="text" placeholder="Search documentation" data-typeahead>
        </form>
      </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="https://github.com/luispadron/UIEmptyState">
            <img class="header-icon" src="../img/gh.png"/>
            View on GitHub
          </a>
        </p>
    
    </header>

    <p class="breadcrumbs">
      <a class="breadcrumb" href="../index.html">UIEmptyState Reference</a>
      <img class="carat" src="../img/carat.png" />
      UIEmptyStateDataSource Protocol Reference
    </p>

    <div class="content-wrapper">
      <nav class="navigation">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/UIEmptyStateView.html">UIEmptyStateView</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/UICollectionViewController.html">UICollectionViewController</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/UITableViewController.html">UITableViewController</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/UIViewController.html">UIViewController</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/UIEmptyStateDataSource.html">UIEmptyStateDataSource</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/UIEmptyStateDelegate.html">UIEmptyStateDelegate</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">

        <section class="section">
          <div class="section-content">
            <h1>UIEmptyStateDataSource</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">UIEmptyStateDataSource</span><span class="p">:</span> <span class="kd">class</span></code></pre>

                </div>
              </div>
            <p>The data source for the Empty View</p>

<p>Default conformance for UIViewContoller is provided,
however feel free to implement these methods to customize your view.</p>

          </div>
        </section>

        <section class="section">
          <div class="section-content">
            <div class="task-group">
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB14ViewShouldShowSbSo07UITableF0C3for_tF"></a>
                    <a name="//apple_ref/swift/Method/emptyStateViewShouldShow(for:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB14ViewShouldShowSbSo07UITableF0C3for_tF">emptyStateViewShouldShow(for:)</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines whether should or should not show the empty view for a specific tableView,
by default it will count tableView rows to determine</p>

<ul>
<li>paramaters:

<ul>
<li>tableView: The tableview which the emptyStateView will display over</li>
</ul></li>
</ul>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation for UIViewController tableView determining if should show the emptystate view,
counts number of rows in the tableView</p>
<p>Default implementation for UIViewController collectionView determining if should show the emptystate view,
counts number of items in the collectionView</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">emptyStateViewShouldShow</span><span class="p">(</span><span class="k">for</span> <span class="nv">tableView</span><span class="p">:</span> <span class="kt">UITableView</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Boolean value of whether view should or should not be displayed</p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB14ViewShouldShowSbSo012UICollectionF0C3for_tF"></a>
                    <a name="//apple_ref/swift/Method/emptyStateViewShouldShow(for:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB14ViewShouldShowSbSo012UICollectionF0C3for_tF">emptyStateViewShouldShow(for:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines whether should or should not show the empty view for a specific collectionView,
by default it will count collectionView items to determine</p>

<ul>
<li>paramaters:

<ul>
<li>collectionView: The collectionView which the emptyStateView will display over</li>
</ul></li>
</ul>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">emptyStateViewShouldShow</span><span class="p">(</span><span class="k">for</span> <span class="nv">collectionView</span><span class="p">:</span> <span class="kt">UICollectionView</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Boolean value of whether view should or should not be displayed</p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB4ViewSo6UIViewCvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateView" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB4ViewSo6UIViewCvp">emptyStateView</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the view to use for the empty state, by default this is a nice stack view</p>

<p><strong>Important:</strong> By default this will return a UIEmptyStateView, implementing this method will
cause the delegation of button and view touches to no longer work,
unless you implement those yourself as well.</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptystateView</code> returns a <code>UIEmptyStateView</code></p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateView</span><span class="p">:</span> <span class="kt">UIView</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB20ViewAdjustsToFitBarsSbvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateViewAdjustsToFitBars" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB20ViewAdjustsToFitBarsSbvp">emptyStateViewAdjustsToFitBars</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines whether the <code><a href="../Protocols/UIEmptyStateDataSource.html#/s:12UIEmptyState0aB10DataSourceP05emptyB4ViewSo6UIViewCvp">emptyStateView</a></code> should adjust to be shown properly inside by
not extending the view past the navigation bar and tab bar of a navigation controller.</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateViewAdjustsToFitBars</code> returns <code>true</code></p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateViewAdjustsToFitBars</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB5TitleSo18NSAttributedStringCvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateTitle" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB5TitleSo18NSAttributedStringCvp">emptyStateTitle</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the title for the Empty View, by default this just returns an intro message,
override for custom title</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateTitle</code>, returns an intro title</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateTitle</span><span class="p">:</span> <span class="kt">NSAttributedString</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB5ImageSo7UIImageCSgvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateImage" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB5ImageSo7UIImageCSgvp">emptyStateImage</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the image which will be used inside the Empty State View&rsquo;s image view, default value is nil</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateImage</code>, returns nil</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateImage</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB9ImageSizeSC6CGSizeVSgvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateImageSize" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB9ImageSizeSC6CGSizeVSgvp">emptyStateImageSize</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the size of the image view, by default this will return nil which means
that the imageview size will just be 100x100</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateImageSize</code>, returns nil</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateImageSize</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB18ImageViewTintColorSo7UIColorCSgvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateImageViewTintColor" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB18ImageViewTintColorSo7UIColorCSgvp">emptyStateImageViewTintColor</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the tintColor to apply to the Empty State View&rsquo;s image view</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of `emptyStateImageViewTintColor, returns nil</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateImageViewTintColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB11ButtonTitleSo18NSAttributedStringCSgvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateButtonTitle" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB11ButtonTitleSo18NSAttributedStringCSgvp">emptyStateButtonTitle</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the title for the button of the Empty State View, by default this is nil</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateButtonTitle</code>, returns nil</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateButtonTitle</span><span class="p">:</span> <span class="kt">NSAttributedString</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB11ButtonImageSo7UIImageCSgvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateButtonImage" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB11ButtonImageSo7UIImageCSgvp">emptyStateButtonImage</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the image for the button, by default this will return nil</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateButtonImage</code>, returns nil</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateButtonImage</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB10ButtonSizeSC6CGSizeVSgvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateButtonSize" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB10ButtonSizeSC6CGSizeVSgvp">emptyStateButtonSize</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the size of the button, by default it will constrain the view to the size
of the title plus some padding.</p>

<p>Implement this method to send a custom size for the button,
useful when adding a buttonImage to the button</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateButtonSize</code>, returns nil,
thus size will be calculated using size of <code>buttonTitle</code></p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateButtonSize</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB13DetailMessageSo18NSAttributedStringCSgvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateDetailMessage" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB13DetailMessageSo18NSAttributedStringCSgvp">emptyStateDetailMessage</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the message which will be displayed in the detail view of the empty state view,
by default this will return an intro message</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateDetailMessage</code>, returns nil</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateDetailMessage</span><span class="p">:</span> <span class="kt">NSAttributedString</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB11ViewSpacing12CoreGraphics7CGFloatVvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateViewSpacing" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB11ViewSpacing12CoreGraphics7CGFloatVvp">emptyStateViewSpacing</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the amount of spacing between the views, by default this is 12</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateViewSpacing</code>, returns 12</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateViewSpacing</span><span class="p">:</span> <span class="kt">CGFloat</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB17ViewCenterYOffset12CoreGraphics7CGFloatVSgvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateViewCenterYOffset" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB17ViewCenterYOffset12CoreGraphics7CGFloatVSgvp">emptyStateViewCenterYOffset</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the vertical offset space, by default Empty State View is centered in the vertical axis</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateCenterYOffset</code>, returns nil</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateViewCenterYOffset</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB15BackgroundColorSo7UIColorCvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateBackgroundColor" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB15BackgroundColorSo7UIColorCvp">emptyStateBackgroundColor</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Determines the background color for the emptyStateView, by default this value is UIColor.clear</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateBackgroundColor</code>, returns <code>UIColor.clear</code></p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateBackgroundColor</span><span class="p">:</span> <span class="kt">UIColor</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB13ViewCanScrollSbvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateViewCanScroll" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB13ViewCanScrollSbvp">emptyStateViewCanScroll</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Whether the empty state view allows scrolling or not, by default this is false</p>

<p><strong>Note:</strong> This is only called when view is displayed, if not displayed scrolling will be enabled for the table view</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateViewCanScroll</code>, returns <code>false</code></p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateViewCanScroll</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB14ViewCanAnimateSbvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateViewCanAnimate" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB14ViewCanAnimateSbvp">emptyStateViewCanAnimate</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Whether the empty state view should animate or not</p>

<p><strong>Note:</strong>
This is called whenever the empty state view will show, if false; no animation will occur. Default = true</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateViewCanAnimate</code>, returns <code>true</code></p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateViewCanAnimate</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB21ViewAnimatesEverytimeSbvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateViewAnimatesEverytime" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB21ViewAnimatesEverytimeSbvp">emptyStateViewAnimatesEverytime</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Whether the empty state view animates every time it is shown</p>

<p><strong>Note:</strong>
This is called whenever the empty state view will show, returning true means that an animation
from <code>emptyStateViewAnimation</code> will be performed everytime the view is shown
returning false means that only the inital animation is shown.
To turn off animation in general use <code><a href="../Protocols/UIEmptyStateDataSource.html#/s:12UIEmptyState0aB10DataSourceP05emptyB14ViewCanAnimateSbvp">emptyStateViewCanAnimate</a></code></p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateViewAnimatesEverytime</code>, returns <code>false</code></p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateViewAnimatesEverytime</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB21ViewAnimationDurationSdvp"></a>
                    <a name="//apple_ref/swift/Property/emptyStateViewAnimationDuration" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB21ViewAnimationDurationSdvp">emptyStateViewAnimationDuration</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The amount of time the empty state view should animate for</p>

<p><strong>Note:</strong>
This is called whenever the empty state view will show, Default = 0.5</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateViewAnimationDuration</code>, returns <code>0.5</code></p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">emptyStateViewAnimationDuration</span><span class="p">:</span> <span class="kt">TimeInterval</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12UIEmptyState0aB10DataSourceP05emptyB13ViewAnimationySo6UIViewC3for_Sd17animationDurationySbcSg10completiontF"></a>
                    <a name="//apple_ref/swift/Method/emptyStateViewAnimation(for:animationDuration:completion:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12UIEmptyState0aB10DataSourceP05emptyB13ViewAnimationySo6UIViewC3for_Sd17animationDurationySbcSg10completiontF">emptyStateViewAnimation(for:animationDuration:completion:)</a>
                    </code>
                      <span class="declaration-note">
                        Default implementation
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The animation function for the views in the empty state view</p>

<p><strong><em>Note:</em></strong> This is called whenever the empty state view will show, Default = pop in and fade in of views</p>

                      </div>
                      <h4>Default Implementation</h4>
                      <div class="default_impl abstract">
                        <p>Default implementation of <code>emptyStateViewAnimation</code>, implements a simple animation</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">emptyStateViewAnimation</span><span class="p">(</span><span class="k">for</span> <span class="nv">view</span><span class="p">:</span> <span class="kt">UIView</span><span class="p">,</span> <span class="nv">animationDuration</span><span class="p">:</span> <span class="kt">TimeInterval</span><span class="p">,</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>view</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The view which will be animated, can be used to control its properties inside a <code>UIView.animate</code> block</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>animationDuration</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The duration which we should animate for,
                 value is grabbed from <code><a href="../Protocols/UIEmptyStateDataSource.html#/s:12UIEmptyState0aB10DataSourceP05emptyB21ViewAnimationDurationSdvp">emptyStateViewAnimationDuration</a></code></p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>completion</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The completion block for the emptyStateView,
          if implementing this pass this to the <code>UIView.animate</code> completion block
          in order for the delegate to work properly</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </div>
        </section>

      </article>
    </div>
    <section class="footer">
      <p>&copy; 2018 <a class="link" href="https://luispadron.com" target="_blank" rel="external">Luis</a>. All rights reserved. (Last updated: 2018-04-09)</p>
      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
    </section>
  </body>
</div>
</html>
